-
Notifications
You must be signed in to change notification settings - Fork 3.6k
docs: clarify DeviceStatsMonitor
logged metrics
#20895
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Borda
merged 11 commits into
Lightning-AI:master
from
MrAnayDongre:docs/fix-20807-device-stats-metrics
Sep 3, 2025
Merged
docs: clarify DeviceStatsMonitor
logged metrics
#20895
Borda
merged 11 commits into
Lightning-AI:master
from
MrAnayDongre:docs/fix-20807-device-stats-metrics
Sep 3, 2025
+61
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Borda
reviewed
Jun 12, 2025
798f9c9
to
2461f52
Compare
Borda
reviewed
Jun 18, 2025
1afe3a5
to
c707a02
Compare
271e5d7
to
fd323ed
Compare
for more information, see https://pre-commit.ci
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://lightning.ai/docs/pytorch/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Discord. Thank you for your contributions. |
Borda
reviewed
Aug 8, 2025
SkafteNicki
approved these changes
Sep 3, 2025
Borda
approved these changes
Sep 3, 2025
Borda
reviewed
Sep 3, 2025
DeviceStatsMonitor
logged metrics
Borda
added a commit
that referenced
this pull request
Sep 3, 2025
* DOC: Clarify DeviceStatsMonitor logged metrics (#20807) * update * use nested list * Apply suggestions from code review --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jirka B <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Nicki Skafte <[email protected]> (cherry picked from commit 9f757c0)
lantiga
pushed a commit
that referenced
this pull request
Sep 5, 2025
* DOC: Clarify DeviceStatsMonitor logged metrics (#20807) * update * use nested list * Apply suggestions from code review --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jirka B <[email protected]> Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Nicki Skafte <[email protected]> (cherry picked from commit 9f757c0)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR addresses issue #20807 by adding detailed documentation for the metrics logged by
DeviceStatsMonitor
.The key clarifications include:
psutil
, CUDA GPU viatorch.cuda.memory_stats
, and other accelerators viaaccelerator.get_device_stats()
).DeviceStatsMonitor.{hook_name}/{base_metric_name}
.torch.cuda.memory_stats()
for the full list of memory metrics.profiler_basic.rst
to align with these clarifications and link to the API docs.This documentation aims to help users understand what statistics to expect when using
DeviceStatsMonitor
with different hardware configurations.Fixes #20807
No breaking changes are introduced by this documentation update.
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--20895.org.readthedocs.build/en/20895/